home *** CD-ROM | disk | FTP | other *** search
/ Aminet 23 / Aminet 23 (1998)(GTI - Schatztruhe)[!][Feb 1998].iso / Aminet / misc / emu / amiSPIMsrc.lha / readme < prev    next >
Text File  |  1994-01-18  |  7KB  |  251 lines
  1.              README file for SPIM & XSPIM
  2.  
  3.  
  4. SPIM is copyrighted by James R. Larus and distributed under the
  5. following conditions:
  6.  
  7.     You may make copies of SPIM for your own use and modify those copies.
  8.  
  9.     All copies of SPIM must retain my name and copyright notice.
  10.  
  11.     You may not sell SPIM or distributed SPIM in conjunction with a
  12.     commercial product or service without the expressed written consent of
  13.     James Larus.
  14.  
  15. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  16. IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  17. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18. PURPOSE.
  19.  
  20. This directory contains SPIM--an assembly language MIPS R2000/R3000
  21. simulator.  The files are:
  22.  
  23. BLURB
  24.     A short description of SPIM.
  25.  
  26. Configure
  27.     A shell script to configure SPIM.
  28.  
  29. IMakefile
  30.     Input to the xmkmf program, which produces a Makefile.
  31.  
  32. Makefile.std
  33.     The descriptor file for make utility program.  Use this file if you
  34.     do not have xmkmf.
  35.  
  36. README    This file.
  37.  
  38. VERSION
  39.     Version number of system.
  40.  
  41. buttons.c, buttons.h
  42.     X-interface code for command buttons.
  43.  
  44. data.c, data.h
  45.     Code to handle data directives.
  46.  
  47. inst.c, inst.h
  48.     Code to build instructions and manipulate symbol table.
  49.  
  50. mem.c, mem.h
  51.     Code to maintain memory.
  52.  
  53. mips-syscall.c, mips-syscall.h
  54.     Code to handle system calls and exceptions.
  55.  
  56. op.h
  57.     Definition of operations.
  58.  
  59. parser.y, parser.h
  60.     Assembly command parser (YACC).
  61.  
  62. read-aout.c, read-aout.h
  63.     Code to read MIPS a.out executables.
  64.  
  65. reg.h
  66.     Register access macros.
  67.  
  68. run.c, run.h
  69.     Instruction simulator.
  70.  
  71. scanner.l, scanner.h
  72.     Lexical analyzer (LEX).
  73.  
  74. spim-syscall.h
  75.     System call numbers.
  76.  
  77. spim-utils.c, spim-utils.h
  78.     Misc. routines.
  79.  
  80. spim.c, spim.h
  81.     Top-level interface.
  82.  
  83. sym-tbl.c, sym-tbl.h
  84.     Symbol table.
  85.  
  86. windows.c, windows.h
  87.     X-interface code to build windows.
  88.  
  89. xspim.c, xspim.h
  90.     Top-level X-interface.
  91.  
  92. trap.handler
  93.     Standard trap handler.
  94.  
  95. Tests
  96.     Subdirectory contain torture tests to verify that SPIM works.
  97.  
  98. Documentation/spim.tex
  99.     TeX document that describes SPIM.
  100.  
  101. Documentation/spim.ps
  102.     Postscript version of TeX document.
  103.  
  104. Documentation/SPIM_and_LINUX
  105.     Describes changes necessary to SPIM to run under LINUX.
  106.     (Since I don't have a system running LINUX, I can't test for these
  107.     changes or answer questions about them.)
  108.  
  109. Documentation/cycle.ps
  110.     Describes Anne Roger's cycle-level simulator (cl-spim, cl-xspim).
  111.  
  112.  
  113.  
  114. To make SPIM, run the shell script Configure:
  115.  
  116.     % Configure
  117.  
  118. and edit the first few lines of Imakefile to set the parameters for
  119. your system.  Then type:
  120.  
  121.     % xmkmf
  122.     % make
  123.  
  124. (Note: on RS6000's running AIX, you should edit the Makefile to use the xlc
  125. compiler rather than cc.)
  126.  
  127. If you want an X-window version of SPIM, also type:
  128.  
  129.     % make xspim
  130.  
  131. If you do not have X-windows or the program xmkmf, edit the makefile
  132. in Makefile.std and type:
  133.  
  134.     % make -f Makefile.std test
  135.     % make -f Makefile.std xspim
  136.  
  137. To run spim or xspim, the trap handler code must be installed in the
  138. directory specified by the variable TRAP_DIR in the Makefile.  If the file
  139. trap.handler is not installed, spim and xspim fail with a message before
  140. they start running.  You can either install this file by hand or by typing
  141.  
  142.     % make install
  143.  
  144. To test that spim is correctly built, type
  145.  
  146.     % make test
  147.  
  148. and examine the output of the test.  (Note: the trap handler must be installed
  149. before running the test.)
  150.  
  151.  
  152.  
  153.           What about SPIM on system XYZ????
  154.  
  155. SPIM should run without many changes on most Unix systems (the great
  156. thing about Unix standards are that there are so many to choose
  157. from...).  I, obviously, have not tested SPIM on many system, nor can
  158. I port SPIM to systems that I don't have.  However, I would like to
  159. hear about the changes necessary to run SPIM on your favorite system.
  160.  
  161. In addition, Morgan-Kaufmann Publishers (in conjunction with Patterson
  162. & Hennessy's book "Computer Organization & Design: The Hardware /
  163. Software Interface") distributes a version of SPIM that runs on PC
  164. (under DOS) and Macintoshes.  It is based on an older version of SPIM,
  165. so it has a few minor incompatibilities with this version of SPIM.
  166. Since I didn't do the port, I can't answer questions or distribute
  167. these programs; however I will forward bug reports to its maintainers.
  168.  
  169.  
  170. This release (5.4) of SPIM and XSPIM has been compiled and tested on the
  171. following systems:
  172.  
  173.     DECStation 3100 running Ultrix 4.2A using cc and gcc
  174.     SPARCstation IPX running Sun OS 4.1.3 (with AFS) using cc, gcc, & acc.
  175.  
  176. This release (5.2) of SPIM and XSPIM has been compiled and tested on the
  177. following systems:
  178.  
  179.     DECStation 3100 running Ultrix 4.2A using cc and gcc
  180.     SPARCstation IPX running Sun OS using cc and gcc
  181.     RS6000 running AIX 3.2 using xlc
  182.     HP 720 (Snake) running HP-UX using cc and gcc
  183.  
  184.  
  185.  
  186. Although SPIM is free software, it cost time and money to produce.  If
  187. you use SPIM and work in industry, you can help support development of
  188. software of this sort by having your company make a donation to my
  189. research program.  To do this, mail me check (address attached)
  190. payable to ``Computer Sciences Fund -- University of Wisconsin
  191. Foundation.''  The foundation's federal taxpayer identification number
  192. is 39-074-3975.
  193.  
  194. James Larus
  195. larus@cs.wisc.edu
  196. Computer Sciences Department
  197. 1210 West Dayton Street
  198. University of Wisconsin
  199. Madison, WI 53706 USA
  200. 608-262-9519
  201.  
  202.  
  203.  
  204. This directory also contains a cycle-level SPIM simulator developed by
  205. Anne Rogers and and Scott Rosenberg of Princeton.
  206.  
  207. The following copyright applies to all new files in cl-spim and cl-xspim:
  208.  
  209. SPIM S20 MIPS Cycle Level simulator.
  210. Copyright (C) 1991-1992 by Anne Rogers (amr@cs.princeton.edu) and
  211. Scott Rosenberg (scottr@cs.princeton.edu)
  212. ALL RIGHTS RESERVED.
  213.  
  214. CL-SPIM is distributed under the following conditions:
  215.  
  216.   You may make copies of CL-SPIM for your own use and modify those copies.
  217.  
  218.   All copies of CL-SPIM must retain our names and copyright notice.
  219.  
  220.   You may not sell CL-SPIM or distributed CL-SPIM in conjunction with a
  221.   commercial product or service without the expressed written consent of
  222.   Anne Rogers.
  223.  
  224. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  225. IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  226. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  227. PURPOSE.
  228.  
  229.  
  230. New files for cl-spim and cl-xspim, cycle level simulators:
  231.  
  232. cl-cycle.[ch]
  233.     pipeline simulation
  234.  
  235. cl-except.[ch]
  236.     exception and signal handling
  237.  
  238. cl-tlb.[ch]
  239.     virtual memory simulation
  240.  
  241. cl-cache.[ch]
  242.     instruction and data caching simulation
  243.  
  244.  
  245. To make cl-spim or cl-xspim, type:
  246.  
  247.     % make cl-spim
  248.     % make cl-xspim
  249.  
  250. $Header: /var/home/larus/Software/SPIM/RCS/README,v 1.12 1994/01/18 15:25:18 larus Exp larus $
  251.